﻿/*
 * DG (DG Gaming Engine)  - API
 * Copyright (C) 2004  Bob Marks (marksie531@yahoo.com)
 * http://code.google.com/p/dng-gaming
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package com.dg.gaming.api.common.msg{
	import com.ericfeminella.collections.ArrayList;


	import nanoxml.XMLElement;

	/**
	 * Communication object which will send a XMLElement as a child
	 * from a client to server (or or vice versa).  Used in the DGController
	 * to simplify the sending and receiving of more complex data.
	 *
	 * @author  Bob Marks
	 * @version Alpha 0.2.3
	 */
	public class MsgControllerObject extends MsgTableMessage {

		/**
		     * XMLElement of data.
		     */
		protected var data:XMLElement;


		/**
		     * Constructor which takes an XMLElement.
		     *
		     * @param message
		     */
		public function MsgControllerObject(message:XMLElement=null) {
			super(message);
			if (message!=null) {
				var children:Array=message.chileds;
				if (children.length==1) {// should have one child as its data
					this.data=XMLElement(children[0]);
				}
			}
		}

		/**
		     * Set data.
		     *
		     * @param data
		     */
		public function setData(data:XMLElement):void {
			this.data=data;// set data
		}

		/**
		     * Return the data back to the user.
		     *
		     * @return   Data as XML object.
		     */
		public function getData():XMLElement {
			return data;
		}

		/**
		     * @see com.dg.gaming.api.common.msg.ITransmittable#flatten()
		     */
		public override function flatten():XMLElement {
			var message:XMLElement=flattenWithName(Msg.CONTROLLER_OBJECT);
			message.addChild(data);

			return message;
		}
	}
}